﻿/*
 * DG (DG Gaming Engine)  - API
 * Copyright (C) 2004  Bob Marks (marksie531@yahoo.com)
 * http://code.google.com/p/dng-gaming
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package com.dg.gaming.api.common.msg
{
	import nanoxml.XMLElement;
	import com.dg.gaming.api.common.TransmissionException;

	/**
	 * Communications object which is used when one user offers a draw to another
	 * user.
	 *
	 * @author  Bob Marks
	 * @version Alpha 0.2.3
	 */
	public class MsgOfferDraw extends MsgTableMessage
	{

		// The serial number of this draw offer message
		private var serialNumber:int=0;

		public static const XML_ATT_SERIAL_NUM:String="sn";



		/**
		 * Constructor which creates a CommOfferDraw object from the flatten ()
		 * method of another CommInvite object.
		 *
		 * @param message
		 * @throws TransmissionException
		 */
		public function MsgOfferDraw(status:int=-1, userId:Number=-1, message:XMLElement=null)
		{

			initStatus(status);
			initUserId(userId);
			if (message != null)
				super(message);

			if (message == null)
			{
				return;
			}
			if (message.name != Msg.OFFER_DRAW)
			{
				throw new TransmissionException("Error parsing CommOfferDraw");
			}

			serialNumber=message.getIntAttribute(XML_ATT_SERIAL_NUM, 0);
		}

		/**
		 * Set the serial number of the offer message.
		 *
		 * @param newSerialNum    The new serial number of the message.
		 */
		public function setSerialNum(newSerialNum:int):void
		{
			serialNumber=newSerialNum;
		}

		/**
		 * Get the serial number of the offer message.
		 */
		public function getSerialNum():int
		{
			return serialNumber;
		}

		/**
		 * Flatten the String.
		 *
		 * @see com.dg.gaming.api.common.msg.ITransmittable#flatten()
		 */
		public override function flatten():XMLElement
		{
			var message:XMLElement=super.flattenWithName(Msg.OFFER_DRAW);

			message.setIntAttribute(XML_ATT_SERIAL_NUM, serialNumber);

			return message;
		}
	}
}